POST api/users/{authenticationToken}

This method is used to return a list of Epic users based on their active state and user type.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
authenticationToken

Current authentication token

 string

Required

Body Parameters

Identifies the type of users to return. Also determines if only the active users should be returned.

UserCriteriaModel
NameDescriptionTypeAdditional information
WantActiveOnly

This property indicates whether only active users should be returned or if all users should be returned.

 boolean

None.
UserType

This property is the desired user type for getting a list of users. Valid user types are Internal, Client, and Customer. If nothing is passed in, then all system types will be returned.

 string

None.
Email

This property allows for finding a user's information by email address.

 string

None.

Request Formats

application/json, text/json

Sample: 
{
  "WantActiveOnly": true,
  "UserType": "sample string 2",
  "Email": "sample string 3"
}

application/xml, text/xml

Sample: 
<UserCriteriaModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EpicAPI.Models">
  <Email>sample string 3</Email>
  <UserType>sample string 2</UserType>
  <WantActiveOnly>true</WantActiveOnly>
</UserCriteriaModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

A report of desired loans.

Collection of UserModel
NameDescriptionTypeAdditional information
UserKey

This is the user identifier for the user.

 string

None.
FirstName

This is the first name of the user.

 string

None.
MiddleName

This is the middle name of the user.

 string

None.
LastName

This is the last name of the user.

 string

None.
SuffixName

This is the suffix name of the user.

 string

None.
Email

This is the email address of the user.

 string

None.
Status

This is the status of the user. Valid status options are Active, Inactive, and Locked.

 string

None.
Type

This is the type of user account. Valid types are Internal, Client, and Customer.

 string

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "UserKey": "sample string 1",
    "FirstName": "sample string 2",
    "MiddleName": "sample string 3",
    "LastName": "sample string 4",
    "SuffixName": "sample string 5",
    "Email": "sample string 6",
    "Status": "sample string 7",
    "Type": "sample string 8"
  },
  {
    "UserKey": "sample string 1",
    "FirstName": "sample string 2",
    "MiddleName": "sample string 3",
    "LastName": "sample string 4",
    "SuffixName": "sample string 5",
    "Email": "sample string 6",
    "Status": "sample string 7",
    "Type": "sample string 8"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfUserModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EpicAPI.Models">
  <UserModel>
    <Email>sample string 6</Email>
    <FirstName>sample string 2</FirstName>
    <LastName>sample string 4</LastName>
    <MiddleName>sample string 3</MiddleName>
    <Status>sample string 7</Status>
    <SuffixName>sample string 5</SuffixName>
    <Type>sample string 8</Type>
    <UserKey>sample string 1</UserKey>
  </UserModel>
  <UserModel>
    <Email>sample string 6</Email>
    <FirstName>sample string 2</FirstName>
    <LastName>sample string 4</LastName>
    <MiddleName>sample string 3</MiddleName>
    <Status>sample string 7</Status>
    <SuffixName>sample string 5</SuffixName>
    <Type>sample string 8</Type>
    <UserKey>sample string 1</UserKey>
  </UserModel>
</ArrayOfUserModel>